#ifndef _MDGModifier
#define _MDGModifier
//-
// ==========================================================================
// Copyright (C) 1995 - 2006 Autodesk, Inc., and/or its licensors.  All
// rights reserved.
//
// The coded instructions, statements, computer programs, and/or related
// material (collectively the "Data") in these files contain unpublished
// information proprietary to Autodesk, Inc. ("Autodesk") and/or its
// licensors,  which is protected by U.S. and Canadian federal copyright law
// and by international treaties.
//
// The Data may not be disclosed or distributed to third parties or be
// copied or duplicated, in whole or in part, without the prior written
// consent of Autodesk.
//
// The copyright notices in the Software and this entire statement,
// including the above license grant, this restriction and the following
// disclaimer, must be included in all copies of the Software, in whole
// or in part, and all derivative works of the Software, unless such copies
// or derivative works are solely in the form of machine-executable object
// code generated by a source language processor.

// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND.
// AUTODESK DOES NOT MAKE AND HEREBY DISCLAIMS ANY EXPRESS OR IMPLIED
// WARRANTIES INCLUDING, BUT NOT LIMITED TO, THE WARRANTIES OF
// NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE,
// OR ARISING FROM A COURSE OF DEALING, USAGE, OR TRADE PRACTICE. IN NO
// EVENT WILL AUTODESK AND/OR ITS LICENSORS BE LIABLE FOR ANY LOST
// REVENUES, DATA, OR PROFITS, OR SPECIAL, DIRECT, INDIRECT, OR
// CONSEQUENTIAL DAMAGES, EVEN IF AUTODESK AND/OR ITS LICENSORS HAS
// BEEN ADVISED OF THE POSSIBILITY OR PROBABILITY OF SUCH DAMAGES.
// ==========================================================================
//+
//
// CLASS:    MDGModifier
//
// ****************************************************************************
//
// CLASS DESCRIPTION (MDGModifier)
//
// An MDGModifier is used to change the structure of the dependency
// graph.  This includes adding nodes, making new connections, and
// removing existing connections.  An MDGModifier keeps track of all
// operations that it is used for, so that they can be undone or
// redone.  Calling undo causes an MDGModifier to undo all of the
// dependency graph changes that it has done.
//
// ****************************************************************************

#if defined __cplusplus

// ****************************************************************************
// INCLUDED HEADER FILES


#include <maya/MStatus.h>
#include <maya/MFnDependencyNode.h>

// ****************************************************************************
// DECLARATIONS

class TdependNode;
class Tattribute;
class TattributeList;
class Tstring;
class Tmetaclass;
class MAngle;
class MDistance;
class MObject;
class MPlug;
class MTime;
class MTypeId;
class MString;
class MNodeClass;

// ****************************************************************************
// CLASS DECLARATION (MDGModifier)

//! \ingroup OpenMaya
//! \brief Dependency graph modifier. 
/*!
 An MDGModifier is used to change the structure of the dependency
 graph.  This includes adding nodes, making new connections, and
 removing existing connections.  To  perform operations using an
 MDGModifier, register all of the changes that are to be made and then
 call the doIt method to make the changes.  Undo is provided through
 the undoIt method.

 Under some situations, a doIt() call may be required to separate
 some of the operations. The specific case of interest involves
 performing a disconnect() and a deleteNode() on the same node
 within the stack of operations.

 Assuming that the Maya model has a connected node that was going
 to be deleted, do the following:

 \code
	MStatus cmd::redoIt()
	{
		MStatus result = dgModifier.disconnect(plugA, plugB);
		if (!result)
			...
		result = dgModifier.doIt();
		if (!result)
			...

		result = dgModifier.deleteNode(plugBNode);
		if (!result)
			...

		result = dgModifier.doIt();
		if (!result)
			...

		return result;
	}
 \endcode

 Then undoIt() can be implemented as:

 \code
	MStatus cmd::undoIt()
	{
		MStatus result = dgModifier.undoIt();
		if (!result)
			...
		return result;
	}
  \endcode
*/
class OPENMAYA_EXPORT MDGModifier
{
public:
	MDGModifier();
	virtual ~MDGModifier();

    MObject     createNode( const MTypeId &typeId,
                            MStatus* ReturnStatus = NULL );
    MObject     createNode( const MString &type,
                            MStatus* ReturnStatus = NULL );
    MStatus     deleteNode( const MObject & node );

    MStatus     renameNode( const MObject & node, const MString &newName );

	MStatus		setNodeLockState( const MObject & node, bool newState );

	MStatus		connect(	const MObject & sourceNode,
							const MObject & sourceAttr,
							const MObject & destNode,
							const MObject & destAttr );
	MStatus		disconnect(	const MObject & sourceNode,
							const MObject & sourceAttr,
							const MObject & destNode,
							const MObject & destAttr );
	MStatus		connect(	const MPlug& source, const MPlug& dest );
	MStatus		disconnect(	const MPlug& source, const MPlug& dest );

    MStatus     addAttribute	( const MObject& node, const MObject& attribute );
    MStatus     removeAttribute	( const MObject& node, const MObject& attribute );

    MStatus     addExtensionAttribute	( const MNodeClass& nodeClass,
										  const MObject& attribute );
    MStatus     removeExtensionAttribute( const MNodeClass& nodeClass,
										  const MObject& attribute );
    MStatus     removeExtensionAttributeIfUnset( const MNodeClass& nodeClass,
												 const MObject& attribute );
	MStatus		linkExtensionAttributeToPlugin(
										  const MObject& plugin,
										  const MObject& attribute );
	MStatus		unlinkExtensionAttributeFromPlugin(
										  const MObject& mPlugin,
										  const MObject& mAttribute );

	MStatus		commandToExecute( const MString& command );
    
	MStatus		newPlugValue( const MPlug& plug, MObject& plugValue );
	MStatus		newPlugValueBool( const MPlug& plug, bool plugValue );
	MStatus		newPlugValueChar( const MPlug& plug, char plugValue );            
	MStatus		newPlugValueDouble( const MPlug& plug, double plugValue );
	MStatus		newPlugValueFloat( const MPlug& plug, float plugValue );
	MStatus		newPlugValueInt( const MPlug& plug, int plugValue );
	MStatus		newPlugValueMAngle( const MPlug& plug, const MAngle& plugValue );
	MStatus		newPlugValueMDistance( const MPlug& plug, const MDistance& plugValue );    
	MStatus		newPlugValueMTime( const MPlug& plug, const MTime& plugValue );
	MStatus		newPlugValueShort( const MPlug& plug, short plugValue );    
	MStatus		newPlugValueString( const MPlug& plug, const MString& plugValue );
    
	MStatus		doIt();
	MStatus		undoIt();

	static const  char*	className();

	// Obsolete
    MStatus     addAttribute	( const MObject& node, const MObject& attribute,
							  	  MFnDependencyNode::MAttrClass type );
	// Obsolete
    MStatus     removeAttribute	( const MObject& node, const MObject& attribute,
							  	  MFnDependencyNode::MAttrClass type );

protected:
    MDGModifier( void * );
	MDGModifier( const MDGModifier & other );
	MDGModifier&	operator =( const MDGModifier & rhs );
	bool		checkCompoundAttrs(const TattributeList&, const Tstring&, const Tstring&);
	bool		attrExistsAtNode(TdependNode*, Tattribute*);
	void*		  data;
	bool		  fOwn;

private:
	MObject		createNodeFromMetaClass( Tmetaclass* typid, MStatus* ReturnStatus = NULL );
};

#endif /* __cplusplus */
#endif /* _MDGModifier */
